/***************************************************************************
 *   Copyright (C) 2009 by Bernhard Neuhofer   *
 *   mail@bneu.at   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef PROXY_H
#define PROXY_H

#include <string>
#include <vector>
#include "gvtStats.h"

/**
* @brief Defines methods common to all submodel manager proxys, regardless of the 
* distributed object paradigm in use
*/
class Proxy
{
public:
  
	/**
	 *        Remote invokable method for the SM setup
	 * @param schedType 
	 * @param endGvt 
	 */
	virtual void initSm(string  schedType,double endGvt)=0;
	/**
	 *        Remote invokable method for LP setup
	 * @param id 
	 * @param neighbors 
	 * @param meClass 
	 * @param lpClass 
	 * @param adClass 
	 */
	virtual void initLp(unsigned int id,vector<unsigned int> neighbors, string meClass, string lpClass, string adClass)=0;
	/**
	 *        Remote invokable method for simulation start.
	 */
	virtual void startSim()=0;
	/**
	 *        Remote invokable method to initiate a cut (used by GVT algo)
	 * @param cutC 
	 * @return 
	 */
	virtual GvtStats* cut(bool cutC)=0;
	/**
	 *        Sets the GVT
	 * @param gvt 
	 */
	virtual void setGvt (double gvt)=0;
	/**
	 *        Collects the SmOutput object
	 * @return 
	 */
	virtual int collectOutput()=0;
	/**
	 *        used by the main program to shut the SM down.
	 */
	virtual void shutdown()=0;

};

#endif